Skip to content
This repository has been archived by the owner on Nov 26, 2024. It is now read-only.

regtest: Try to fix docs #8

Merged
merged 5 commits into from
Jun 17, 2024
Merged

regtest: Try to fix docs #8

merged 5 commits into from
Jun 17, 2024

Conversation

tcharding
Copy link
Member

@tcharding tcharding commented Jun 17, 2024

The regtest crate is not typical in that it expects at least one of the "verison number" features to be enabled. This does not play nicely with the docs.rs build. In an effort to make things at least uderstandable do a few things:

  • inline the Client and json docs
  • configure docs.rs build to enable 26_0
  • Add a big fat note to hopefully alleviate the misleading "Available on crate feature 26_0 only."

I did a bad thing and pushed patches to master then cut a release of
`bitcoind-json-rpc-client` without using a PR, and forgot to update lock
files - so here it is.
Its "features" not "feadures", fix multiple instances of the typo.
The readme is stale because it is the one we grabbed when importing
`bitcoind`. Since this crate is currently being release under a
different name remove the stale docs that are specific to `bitcoind`.
The crate is not typical in that it expects at least one of the "verison
number" features to be enabled. This does not play nicely with the
docs.rs build. In an effort to make things at least uderstandable add do
a few things:

- inline the `Client` and `json` docs
- configure docs.rs build to enable 26_0
- Add a big fat note to hopefully alleviate the misleading
  "Available on crate feature 26_0 only."
In preparation for doing a point release bump the version and add a
changelog.
@tcharding tcharding merged commit bc2870f into master Jun 17, 2024
25 checks passed
@tcharding tcharding deleted the 06-17-docs branch June 17, 2024 05:17
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant